Get locations for the shipment using a query param key instead of authentication

Request

path Parameters

shipmentId

required

string <uuid>

The id of the shipment

query Parameters

key required	string Secret view key authorizing user to see the Shipment
beginDatetime	string <date-time> For requesting data starting at a given date
endDatetime	string <date-time> For requesting data ending at a given date
filter_distance	string Applies a distance filter and only returns points greater than filter_distance km apart. To return all, set this to -1

Responses

200

List of locations for the given Shipment

Response Schema: application/json

Array of objects (ELDDeviceLocation)

tracking_source

string (TrackingSource)

Enum Value	Description
air_tracking	Air Tracking
ch_robinson	CH Robinson
checkcall	Check call
container_tracking	Container tracking
edi	EDI
eld	ELD
mobile_app	Mobile app
rail_car_tracking	Rail Car Tracking
unknown	Unknown
web_app	Web app

tracking_sources

Array of strings (TrackingSource)

Items Enum Value	Description
air_tracking	Air Tracking
ch_robinson	CH Robinson
checkcall	Check call
container_tracking	Container tracking
edi	EDI
eld	ELD
mobile_app	Mobile app
rail_car_tracking	Rail Car Tracking
unknown	Unknown
web_app	Web app

tracking_status

string

Enum: "tracking_not_setup" "not_tracking" "tracking" "tracking_complete"

default

Default error response

get/shipments/external/{shipmentId}/tracking/

Request samples

curl
Node.js
JavaScript
Python
Java

Response samples

200
default

application/json

{"shipment_locations": [{"address": {"city": "string",
"country": "string",
"postal_code": "string",
"state": "string"
},
"device_id": "string",
"event_description": "string",
"lat": 0.1,
"location_name": "string",
"lon": 0.1,
"odometer": 0,
"speed": 0,
"update_time": "2019-08-24T14:15:22Z"
}
],
"tracking_source": "string",
"tracking_sources": ["string"
],
"tracking_status": "tracking_not_setup"
}